home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Complementary Applications 2004 February / SGI IRIX 6.5 Complementary Applications 2004 February.iso / dist / cde.idb / usr / dt / dthelp / help4help / C / Reference.z / Reference
Encoding:
Text File  |  2003-11-18  |  26.0 KB  |  992 lines

  1. <!-- Reference -->
  2.  
  3. <!-- Copyright 2000, Silicon Graphics, Inc. -->
  4. <!-- ALL RIGHTS RESERVED -->
  5.  
  6. <!-- UNPUBLISHED Rights reserved under the copyright laws of the United -->
  7. <!-- States.   Use of a copyright notice is precautionary only and does not -->
  8. <!-- imply publication or disclosure. -->
  9.  
  10. <!-- U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND: -->
  11. <!-- Use, duplication or disclosure by the Government is subject to restrictions -->
  12. <!-- as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights -->
  13. <!-- in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or -->
  14. <!-- in similar or successor clauses in the FAR, or the DOD or NASA FAR -->
  15. <!-- Supplement.  Contractor/manufacturer is Silicon Graphics, Inc., -->
  16. <!-- 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311. -->
  17.  
  18. <!-- THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY -->
  19. <!-- INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION, -->
  20. <!-- DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY -->
  21. <!-- PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON -->
  22. <!-- GRAPHICS, INC.  --> 
  23. <!-- Help volume: Help4Help -->
  24. <!-- File name:   Reference -->
  25.  
  26. <chapter id=Reference>Help Reference
  27.  
  28. <idx |reference|
  29.  
  30. <list bullet tight>
  31.  * <xref HelpMenuCommands>
  32.  * <xref HelpMenuShortcutKeys>
  33.  * <xref Mouse-And-Keyboard>
  34.  * <xref HelpWindowsAndDialogBoxes>
  35.  * <xref HelpWindowConfiguration>
  36.  * <xref ErrorMessages>
  37. <\list>
  38.  
  39. <procedure>See Also
  40. <list bullet tight>
  41.  * <xref Tasks>
  42.  * <xref Table-Of-Contents>
  43.  * <link hyperlink="_hometopic">Home Topic<\link>
  44. <\list>
  45.  
  46. <s1 id=HelpMenuCommands>Help Menus
  47.  
  48. <idx |help window menus|
  49. <idx |menus, in help window|
  50.  
  51. The Help menus in the help window are:
  52. <list bullet>
  53. * <xref Help-File-Menu>
  54. * <xref Help-Edit-Menu>
  55. * <xref Help-Search-Menu>
  56. * <xref Help-Navigate-Menu>
  57. * <xref Help-Help-Menu>
  58. * <xref Help-Popup-Menu>
  59. <\list>
  60.  
  61. <procedure>See Also
  62. <list bullet tight>
  63.  * <xref Reference>
  64.  * <xref Tasks>
  65.  * <xref Table-Of-Contents>
  66.  * <link hyperlink="_hometopic">Home Topic<\link>
  67. <\list>
  68.  
  69. <idx |help window menus|
  70.  
  71. <p>&sigspace;
  72.  
  73. <s2 id=Help-File-Menu>Help File Menu
  74.  
  75. <idx |help, File menu|
  76.  
  77. <lablist nowrap>
  78. \Print      \Opens the Print dialog
  79. <location id=HelpMenuPrint>∅<\location>
  80.  
  81.  
  82. \Close      \Closes the help window
  83. <location id=HelpMenuClose>∅<\location>
  84.  
  85. <\lablist>
  86. <note>
  87. When using <link ToBrowseDesktopHelp>Help Manager<\link> to view help information, the
  88. Help File menu includes a New Window command.
  89. <\note>
  90.  
  91. <location id=HelpMenuNewWindow>∅<\location>
  92. <lablist nowrap>
  93. \New Window \Creates a copy of the current general help
  94.    window
  95. <\lablist>
  96.  
  97. <procedure>See Also
  98. <list bullet tight>
  99.  * <xref Printing>
  100.  * <xref ToBrowseDesktopHelp>
  101.  * <xref HelpMenuCommands>
  102.  * <xref Tasks>
  103.  * <xref Table-Of-Contents>
  104.  * <link hyperlink="_hometopic">Home Topic<\link>
  105. <\list>
  106.  
  107. <s2 id=Help-Edit-Menu>Help Edit Menu
  108.  
  109. <idx |help, Edit menu|
  110.  
  111. <lablist nowrap>
  112. \Copy  \Copies selected text to the clipboard
  113. <\lablist>
  114.  
  115. <procedure>See Also
  116. <list bullet tight>
  117.  * <xref CopyingTextFromHelp>
  118.  * <xref HelpMenuCommands>
  119.  * <xref Tasks>
  120.  * <xref Table-Of-Contents>
  121.  * <link hyperlink="_hometopic">Home Topic<\link>
  122. <\list>
  123.  
  124. <s2 id=Help-Search-Menu>Help Search Menu
  125.  
  126. <idx |help, Search menu|
  127.  
  128. <lablist nowrap>
  129.  
  130. \Index \Opens the Index Search dialog box, which lists
  131.    the help volume's key words and phrases
  132.  
  133. <\lablist>
  134.  
  135. <procedure>See Also
  136. <list bullet tight>
  137.  * <xref Index-Search>
  138.  * <xref HelpMenuCommands>
  139.  * <xref Tasks>
  140.  * <xref Table-Of-Contents>
  141.  * <link hyperlink="_hometopic">Home Topic<\link>
  142. <\list>
  143.  
  144. <s2 id=Help-Navigate-Menu>Help Navigate Menu
  145.  
  146. <idx |help, Navigate menu|
  147.  
  148. <lablist nowrap>
  149.  
  150. \Backtrack \ Returns to the previous topic.
  151.  
  152. \Home Topic  \Takes you to the "home topic," or the first
  153. topic of a help volume.  
  154.  
  155. \History  \Opens the History dialog box, which lists help volumes and
  156. topics you've visited.
  157.  
  158. <\lablist>
  159.  
  160. <note>
  161. The Backtrack and Home Topic commands are available in a pop-up menu
  162. in the topic display area.
  163. <\note>
  164.  
  165. <procedure>See Also
  166. <list bullet tight>
  167.  * <xref ToReturnToAPreviousTopic> 
  168.  * <xref ToReturnToTheHomeTopic>
  169.  * <xref History>
  170.  * <xref Help-Popup-Menu>
  171.  * <xref HelpMenuCommands>
  172.  * <xref Tasks>
  173.  * <xref Table-Of-Contents>
  174.  * <link hyperlink="_hometopic">Home Topic<\link>
  175. <\list>
  176.  
  177. <s2 id=Help-Help-Menu>Help Menu
  178.  
  179. <idx |help, Help menu|
  180.  
  181. <lablist nowrap>
  182.  
  183. \Overview - Using Help&sigspace;\  Provides help on using help windows
  184.  
  185. \Table Of Contents \ Displays an outline of the topics in a help volume
  186.  
  187. \Tasks \ Displays task instructions for using the Help System 
  188.  
  189. \Reference\ Displays reference summaries for various Help features, such
  190. as windows and dialog boxes, menus, and resources
  191.  
  192. \Mouse And Keyboard \  Provides information on using the mouse and keyboard
  193. commands in help windows
  194.  
  195. \About Help\ Displays the version and copyright information for the Help System
  196. <\lablist>
  197.  
  198. <procedure>See Also
  199. <list bullet tight>
  200.  * <xref HelpMenuCommands>
  201.  * <xref Tasks>
  202.  * <xref Table-Of-Contents>
  203.  * <link hyperlink="_hometopic">Home Topic<\link>
  204. <\list>
  205.  
  206. <s2 id=Help-Popup-Menu>Help Pop-up Menu
  207.  
  208. A Help pop-up menu is available in a <link GeneralHelpWindow>general help window<\link>. To display
  209. the pop-up menu, point to the topic display area and
  210. press mouse button 3. <newline>
  211. (On a two-button mouse, press both buttons simultaneously.)
  212.  
  213.  
  214. <lablist nowrap>
  215. \Bactrack   \ Returns to the previous topic.
  216. \Home Topic \  Returns to the first topic of a help volume.
  217. <\lablist>
  218.  
  219. <procedure>See Also
  220. <list bullet tight>
  221.  * <xref ToReturnToAPreviousTopic>
  222.  * <xref ToReturnToTheHomeTopic>
  223.  * <xref HelpMenuCommands>
  224.  * <xref Tasks>
  225.  * <xref Table-Of-Contents>
  226.  * <link hyperlink="_hometopic">Home Topic<\link>
  227. <\list>
  228.  
  229. <s1 id=HelpMenuShortcutKeys>Help Menu Shortcut Keys
  230.  
  231. <idx |help, shortcut keys|
  232. <idx |shortcut keys|
  233. <idx |accelerator keys|
  234.  
  235. Use these shortcut keys to activate Help menu commands:
  236.  
  237. <lablist nowrap>
  238. <labheads> \ Command \ Shortcut Key
  239.  
  240. \Print\          Control+P
  241. \Close\          Alt+F4
  242. \Copy\           Control+C
  243. \Index\          Control+I
  244. \Backtrack\      Control+B
  245. \HomeTopic\      Control+H
  246. <\lablist>
  247.  
  248. <note>If your keyboard does not have an Alt key,
  249. ask your system administrator to identify the corresponding key or
  250. refer to your system documentation.
  251. <\note>
  252.  
  253. <p>&sigspace;
  254.  
  255. <procedure>See Also
  256. <list bullet tight>
  257.  * <xref Reference>
  258.  * <xref Tasks>
  259.  * <xref Table-Of-Contents>
  260.  * <link hyperlink="_hometopic">Home Topic<\link>
  261. <\list>
  262.  
  263. <s1 id=Mouse-And-Keyboard>Mouse Actions and Keyboard Commands
  264.  
  265. <idx |keyboard selection|
  266. <idx |text, selecting with keyboard|
  267. <idx |selection, with keyboard|
  268. <idx |keyboard commands|
  269. <idx |mouse, actions in help windows|
  270.  
  271. <procedure>Mouse Actions
  272.  
  273. <lablist nowrap>
  274. <labheads>\Action&sigspace;\                 Behavior
  275. \Click mouse button 1           \Selects a topic in the topic tree or a
  276. hyperlink and displays the content in the current help window.
  277. \Hold mouse button 1 and drag            \Copies selected text to the clipboard.
  278.  
  279. \Control+button&sigspace;1      \Selects a topic in the topic tree or
  280. hyperlink and displays the content in a new window.
  281.  
  282. \Shift+button&sigspace;1      \Same as above.
  283. \Alt+button&sigspace;1    \Same as above.
  284. <\lablist>
  285.  
  286. <note>
  287. If your keyboard does not have an Alt key ask your system administrator to
  288. identify the corresponding key or refer to your system documentation.
  289. <\note>
  290.  
  291. <p>&sigspace;
  292.  
  293. <procedure>Keyboard Commands
  294.  
  295. <idx |keyboard, selecting topics|
  296. <idx |topics, selecting with keyboard|
  297.  
  298. To use your keyboard to display topics or to scroll data, first
  299. move the window selection highlight to the appropriate area of
  300. the help window, such as the topic tree or topic display area.
  301. Press the Tab key to move the selection highlight forward. To move
  302. the highlight backward, press Shift+Tab.
  303.  
  304. You can use these keyboard commands in the following help window
  305. areas:
  306.  
  307.         
  308. <list bullet>
  309. * <term nogloss |Topic Tree|
  310.  
  311. <lablist nowrap>
  312. <labheads>\Key       \ Cursor Action
  313. \ Up Arrow               \ Up one line
  314. \ Down Arrow             \ Down one line
  315. \ Return              \ Display help topic for selected title
  316. \ Control+Return&sigspace;      \ Display help topic for selected
  317. title in a new window
  318. \ Control+/            \ Select topic tree list
  319. \ Control+&\  \ Deselect topic tree list
  320. <\lablist>
  321.  
  322.  
  323. * <term nogloss |Topic Display Area|
  324.  
  325. <lablist nowrap>
  326. <labheads>\Key     \ Behavior
  327.  
  328. \ Up Arrow or Left Arrow    \ Move highlight to previous hyperlink
  329. \ Down Arrow or Right Arrow    \ Move highlight to next hyperlink
  330.  
  331. \ Control+/  \ Select entire topic
  332. \ Control+&\  \ Deselect entire topic
  333. \ Control+C                 \ Copy selection to clipboard
  334. \ Control+V                  \ Paste selection to clipboard
  335. \ Return                    \ Display help topic for the
  336. selected hyperlink
  337. \ Control+Return&sigspace;             \ Display help topic for the
  338. selected hyperlink in a new window
  339. \ Shift+F10            \ Displays the pop-up menu
  340.  
  341. <\lablist>
  342.  
  343.  
  344. * <term nogloss | Help Window|
  345.  
  346. <lablist nowrap>
  347. <labheads>\Key     \ Behavior
  348.  
  349. \Escape                                   \Cancels an operation such as
  350. scrolling or resizing. Otherwise, if there is no current operation, closes the help window.
  351. \Alt key+Up Arrow             \ Moves window to top of window stack. 
  352. \Alt key+Down Arrow&sigspace;       \ Moves window to bottom of window
  353. stack.
  354. <\lablist>  
  355.  
  356.  
  357. * <term nogloss | Buttons|
  358.  
  359.  
  360.  Press Tab to move the selection highlight to the desired button and
  361.  press Return.
  362.  
  363. * <term nogloss | Vertical Scroll Bars|
  364.  
  365. <lablist nowrap>
  366. <labheads>\Key     \ Cursor Movement 
  367. \ Up Arrow               \ Scroll up
  368. \ Down Arrow            \ Scroll down
  369. \ Control+Up Arrow    \ Scroll to top of list or topic
  370. \ Control+Down Arrow&sigspace;  \ Scroll to end of list or topic
  371. \ PageUp or Previous     \ Scroll one screen up
  372. \ PageDown or Next   \ Scroll one screen down
  373. <\lablist>
  374.  
  375. * <term nogloss | Horizontal Scroll Bars|
  376.  
  377. <lablist nowrap>
  378. <labheads>\Key     \ Cursor Movement 
  379. \ Left Arrow             \ Scroll left
  380. \ Control+Left Arrow  \ Scroll to leftmost edge of data
  381. \ Right Arrow            \ Scroll right
  382. \ Control+Right Arrow&sigspace; \ Scroll to rightmost edge of data
  383.  
  384. <\lablist>
  385.  
  386. <\list>
  387.  
  388. <procedure>See Also
  389. <list bullet tight>
  390.  * <xref Reference>
  391.  * <xref Tasks>
  392.  * <xref Table-Of-Contents>
  393.  * <link hyperlink="_hometopic">Home Topic<\link>
  394. <\list>
  395.  
  396. <s1 id=HelpWindowsAndDialogBoxes>Help Windows And Dialog Boxes
  397.  
  398. <idx |help window, types of|
  399.  
  400. <list bullet>
  401.  
  402. * <xref GeneralHelpWindow>
  403. * <xref Quick-Help>
  404. * <xref HistoryDlg>
  405. * <xref PrintDlg>
  406. * <xref IndexSearchDlg>
  407. * <xref Volume-Select>
  408. * <xref Execution-Policy>
  409. <\list>
  410.  
  411.  
  412. <procedure>See Also
  413. <list bullet tight>
  414.  * <xref Reference>
  415.  * <xref Tasks>
  416.  * <xref Table-Of-Contents>
  417.  * <link hyperlink="_hometopic">Home Topic<\link>
  418. <\list>
  419.  
  420.  
  421. <s2 id=GeneralHelpWindow>General Help Window
  422.  
  423. <idx |general help window|
  424. <idx |window, general help|
  425.  
  426. A general help window has a menu bar, topic tree, and a topic display area.
  427. The topic tree lists help topics that you can choose. The lower portion of
  428. the window&emdash;the topic display area&emdash;displays the selected
  429. topic. 
  430.  
  431. <figure nonumber entity=Help4HelpGeneralHelp>
  432. <\figure>
  433.  
  434. Any underlined text is a hyperlink. 
  435. You use hyperlinks to &dquote;jump&dquote; to other topics.
  436. See <link ToSelectAHelpTopicHyperlink>To Select a Hyperlink<\link> for a description of hyperlinks.
  437.  
  438. <p>&sigspace;
  439.  
  440. A general help window has these Help Buttons:
  441.  
  442. <lablist nowrap>
  443. \Backtrack\      Returns to a previous topic.
  444.  
  445. \History\       Lists topics and help volumes that you visited and
  446. enables you to redisplay a topic.
  447.  
  448. \Index\ Opens a help index that you can search to find help
  449. on a subject. 
  450. <\lablist>
  451.  
  452.  
  453. <p>&sigspace;
  454.  
  455. <procedure>See Also
  456. <list bullet tight>
  457.  * <xref ToReturnToAPreviousTopic>
  458.  * <xref History>
  459.  * <xref Quick-Help>
  460.  * <xref Reference>
  461.  * <xref Tasks>
  462.  * <xref Table-Of-Contents>
  463.  * <link hyperlink="_hometopic">Home Topic<\link>
  464. <\list>
  465.  
  466.  
  467. <s2 id=Quick-Help>Quick Help Window 
  468.  
  469. <idx |quick help window|
  470. <idx |window, quick help|
  471.  
  472. A quick help window is a streamlined help window. It has a topic display
  473. area and one or more dialog buttons. 
  474.  
  475. <figure nonumber entity=Help4HelpQuickHelp>
  476. <\figure>
  477.  
  478. <p>&sigspace;
  479.  
  480. <lablist><labheads>\ Button \ Action 
  481. \ Close \      Closes the quick help window
  482. \ Backtrack \  Goes to the previous topic  
  483. \ Print \      Displays a Print dialog box
  484. \ Help \       Displays Help on the quick help window
  485. <\lablist>
  486.  
  487. <procedure>See Also
  488. <list bullet tight>
  489.  * <xref Printing>
  490.  * <xref GeneralHelpWindow>
  491.  * <xref Reference>
  492.  * <xref Tasks>
  493.  * <xref Table-Of-Contents>
  494.  * <link hyperlink="_hometopic">Home Topic<\link>
  495. <\list>
  496.  
  497. <s2 id=HistoryDlg>History Dialog Box
  498.  
  499. <idx |Help, History dialog box|
  500.  
  501. <figure nonumber entity=Help4HelpHistory>
  502. <\figure>
  503.  
  504. <p>&sigspace;
  505.  
  506. <lablist nowrap>
  507. \Help Volumes Visited&sigspace;\    Lists help volumes you have visited
  508.  
  509. \Help Topics Visited\     List topics you have visited
  510. <\lablist>
  511.  
  512. To return to a volume or help topic, click its title in the History list.
  513.  
  514. <p>&sigspace;
  515.  
  516. <procedure>See Also
  517. <list bullet tight>
  518.  * <xref History>
  519.  * <xref HelpWindowsAndDialogBoxes>
  520.  * <xref Reference>
  521.  * <xref Tasks>
  522.  * <xref Table-Of-Contents>
  523.  * <link hyperlink="_hometopic">Home Topic<\link>
  524. <\list>
  525.  
  526.  
  527. <s2 id=PrintDlg>Print Dialog Box
  528.  
  529. <idx |Help, Print dialog box|
  530.  
  531. <figure nonumber entity=Help4HelpPrintDialog>
  532. <\figure>
  533.  
  534. <p>&sigspace;
  535.  
  536. <lablist nowrap>
  537. \ Printer \ The Help System uses your default printer (set by the LPDEST environment variable).
  538.  
  539. \Copies\ Type the number of copies you want to print.
  540.  
  541.  
  542. \Paper Size\ Click the paper size button to display the following choices:
  543.  
  544. <lablist nowrap>
  545. \Letter\ 8.5 x 11 in
  546. \Legal\ 8.5 x 14 in
  547. \Executive\ 7.25 x 10.5 in
  548. \A4\ 210 x 297 mm
  549. \B5\ 182 x 257 mm
  550. <\lablist>
  551.  
  552. <\lablist>
  553.  
  554. <lablist nowrap>
  555. \Topics To Print&sigspace;&sigspace;\ Select the topic or topics to print:
  556.  
  557. <lablist nowrap>
  558.  
  559. \ Current Topic\ Print only the displayed topic (the default)
  560.  
  561. \Current and Subtopics\ Print the current topic
  562. and any subtopics it contains
  563.  
  564. \Table of Contents and Index&sigspace;\ Print the Table of
  565. Contents and Index of the help volume
  566.  
  567. \Entire Volume\ Print Table of Contents, Index, and all topics in the help volume
  568. <\lablist>
  569.  
  570. \Print\ Prints the topic or topics you have chosen
  571.  
  572. \Cancel\ Closes the Print dialog box
  573.  
  574. \Help\ Provides a description of the Print dialog box
  575. <\lablist>
  576.  
  577. <procedure>See Also
  578. <list bullet tight>
  579.  * <xref Printing>
  580.  * <xref Reference>
  581.  * <xref Tasks>
  582.  * <xref Table-Of-Contents>
  583.  * <link hyperlink="_hometopic">Home Topic<\link>
  584. <\list>
  585.  
  586. <s2 id=IndexSearchDlg>Index Search Dialog Box
  587.  
  588. <idx |Help, Index Search dialog box|
  589.  
  590. <figure nonumber entity=Help4HelpIndexDialog>
  591. <\figure>
  592.  
  593. <procedure>Search
  594.  
  595. <lablist nowrap>
  596. \Current\ Displays a Help index for the volume that you are viewing. The
  597. current volume is the default.
  598.  
  599.  
  600. \All Volumes\ Displays a combined Help index for all help volumes
  601. registered on your system.
  602.  
  603. \Selected\ Lists available help volumes in a dialog box (see <xref Volume-Select>).
  604. Choose the volumes whose index entries you want to view or search. If you
  605. select volumes and close the dialog box, the Volumes Selected button can
  606. be used to reopen the list of your choices.
  607.  
  608. <\lablist>
  609.  
  610. <procedure>Show
  611.  
  612. <lablist nowrap>
  613. \Complete Index&sigspace;\ Lists all the index entries found for the volume or
  614. volumes you have chosen.
  615.  
  616. \Entries with:\ Type a word or phrase to search for in the index entries
  617. of the volume or volumes you chose.
  618.  
  619. <\lablist>
  620.  
  621. <procedure>Status Line
  622. Indicates if you chose the Complete Index option. If
  623. you search the index, the status line displays the search string or reports "No index entries found".
  624.  
  625. <procedure>Index Display Area
  626. Lists index entries found for the volume or volumes you chose, or
  627. entries that match the search string you entered.
  628.  
  629. <lablist nowrap>
  630. \Start Search\ Searches the index for the word or phrase supplied in the
  631. Entries with field. Pressing Return also activates the search.
  632.  
  633. \Close\ Closes the Index Search dialog box.
  634. <\lablist>
  635.  
  636. <procedure>See Also
  637. <list bullet tight>
  638.  * <xref Index-Search>
  639.  * <xref Reference>
  640.  * <xref Tasks>
  641.  * <xref Table-Of-Contents>
  642.  * <link hyperlink="_hometopic">Home Topic<\link>
  643. <\list>
  644.  
  645.  
  646. <s2 id=Volume-Select>Search Volume Selection Dialog Box
  647.  
  648. <idx |Help, Index Search Volume Selection dialog box|
  649.  
  650. <figure nonumber entity=Help4HelpSearchVolume>
  651. <\figure>
  652. <p>&sigspace;
  653.  
  654. The Search Volume dialog box lists help volumes available on your system.
  655. You can select one or more volumes, whose index entries are then displayed
  656. in the Index Search dialog box. To deselect a volume, click the
  657. volume name again.
  658.  
  659. When you close the Search Volume dialog box, the Select Volumes button in
  660. the Index Search dialog box can be used to reopen the list of choices.
  661.  
  662.  
  663. <procedure>See Also
  664. <list bullet tight>
  665.  * <xref Index-Search>
  666.  * <xref HelpWindowsAndDialogBoxes>
  667.  * <xref Reference>
  668.  * <xref Tasks>
  669.  * <xref Table-Of-Contents>
  670.  * <link hyperlink="_hometopic">Home Topic<\link>
  671. <\list>
  672.  
  673.  
  674. <s2 id=Execution-Policy>Execution Link Confirmation Dialog Box
  675.  
  676. <idx |Help, Execution Link Confirmation dialog box|
  677. <idx |hyperlinks, execution link policy|
  678. <idx |execution link, policy|
  679.  
  680. An execution hyperlink executes a command instead of displaying
  681. a help topic. Because execution links interact with your
  682. system, you can choose how you want the Help System to respond
  683. when an execution link is selected.
  684.  
  685. The Help System default behavior is to display a confirmation
  686. dialog box.
  687.  
  688.  
  689. <figure nonumber entity=Help4HelpExecutionDlg>
  690. <\figure>
  691.  
  692. Execution policy is controlled by the Help dialog widget resource
  693. <computer>DtNexecutionPolicy<\computer>.  The default value is 
  694. <computer>help_execute_query_unaliased<\computer>.
  695.  
  696. To change the default behavior, you add the 
  697. execution policy resource to your <computer>.Xdefaults<\computer>
  698. file for the application you want to change.
  699.  
  700. The set of resource values is:
  701.  
  702. <lablist nowrap>
  703. \<computer>help_execute_all<\computer>\Executes all execution links without
  704. displaying a confirmation dialog box.
  705.  
  706. \<computer>help_execute_query_unaliased<\computer>\ Displays a dialog box
  707. only for those links which do not have execution aliases defined. An
  708. execution alias is a resource that assigns a name to the command executed
  709. by an execution link.
  710.  
  711. \<computer>help_execute_query_all<\computer>\Displays a dialog box for all
  712. execution links
  713.  
  714. \<computer>help_execute_none<\computer>\Disables all execution links, but
  715. displays the execution command in a dialog box
  716.  
  717. <\lablist>
  718.  
  719.  
  720. <procedure>Example
  721. To disable all execution links within your application, perform
  722. these steps:
  723.  
  724. <list order>
  725. * Create an <computer>.Xdefaults<\computer> file in your home directory or
  726. edit the current <computer>.Xdefaults<\computer> file to include this
  727. resource:
  728.  
  729. <ex>
  730. <var>application_name<\var>*executionPolicy:help_execute_none
  731. <\ex>
  732.  
  733. * Replace <emph>application_name<\emph> with the name of the application
  734. you want to change. If you are unsure of the name of the application,
  735. consult your application documentation.
  736.  
  737. * Start the application.
  738.  
  739. * To test your change, choose the application Help menu and display a topic
  740. that contains an execution link.
  741. <\list>
  742.  
  743. <note>Before modifying the execution policy for an application's help
  744. volume, carefully review all execution link commands and their interaction
  745. with your system.  <\note>
  746.  
  747. <p>&sigspace;
  748. For more information about the Help System execution policy
  749. refer to the <emph>Help System Author's and Programmer's Guide<\emph>.
  750.  
  751.  
  752. <procedure>See Also
  753. <list bullet tight>
  754.  * <xref Hyperlinks>
  755.  * <xref HelpWindowsAndDialogBoxes>
  756.  * <xref Reference>
  757.  * <xref Tasks>
  758.  * <xref Table-Of-Contents>
  759.  * <link hyperlink="_hometopic">Home Topic<\link>
  760. <\list>
  761.  
  762.  
  763. <s1 id=HelpWindowConfiguration>Help Window Configuration
  764.  
  765. <idx |help window, color resources|
  766. <idx |color, in help windows|
  767.  
  768. You can change the colors of the topic tree and topic display
  769. area in a help window. You can also modify the default size of
  770. help windows.
  771.  
  772. <list bullet>
  773. * <xref ToChangeHelpWindowColorsForAnApplication>
  774. * <xref ToChangeHelpWindowDefaultSize>
  775. <\list>
  776.  
  777. <procedure>See Also
  778. <list bullet tight>
  779.  * <xref Reference>
  780.  * <xref Tasks>
  781.  * <xref Table-Of-Contents>
  782.  * <link hyperlink="_hometopic">Home Topic<\link>
  783. <\list>
  784.  
  785.  
  786.  
  787. <s2 id=ToChangeHelpWindowColorsForAnApplication>To Change Help Window Colors for an Application
  788.  
  789. <list order>
  790. * Create an <computer>.Xdefaults<\computer> file in your home directory or
  791. edit your current <computer>.Xdefaults<\computer> file to include the
  792. resources shown in the following example. The name of the color you
  793. have chosen follows the : (colon) in the resource specification.
  794.  
  795. * Replace <var>application_name<\var> with the name of the application
  796. you want to change. If you do not know the name of the application,
  797. consult your application documentation.
  798.  
  799. For a list of available colors, check with
  800. your system administrator or refer to your system documentation.
  801.  
  802. * Start the application.
  803.  
  804. * To check the new colors, choose the application Help menu.
  805. <\list>
  806.  
  807.  
  808. <procedure>Example
  809.  
  810. This entry changes the background and foreground colors of
  811. the topic tree (TocArea) and topic display area (DisplayArea)
  812. for general help (DtHelpDialog) and quick help (DtHelpQuickDialog)
  813. windows.
  814.  
  815. Because quick help windows do not have a topic tree, the
  816. <computer>TocArea<\computer> is omitted in the quick help
  817. window resources.
  818.  
  819. <ex>
  820. <var>application_name<\var>*XmDialogShell.DtHelpDialog*DisplayArea.background: blue 
  821. <var>application_name<\var>*XmDialogShell.XmDialogShell.DtHelpDialog*DisplayArea.background: blue
  822. <var>application_name<\var>*XmDialogShell.DtHelpDialog*DisplayArea.foreground: goldenrod
  823. <var>application_name<\var>*XmDialogShell.XmDialogShell.DtHelpDialog*DisplayArea.foreground: yellow
  824. <var>application_name<\var>*XmDialogShell.DtHelpDialog*TocArea.background: blue
  825. <var>application_name<\var>*XmDialogShell*XmDialogShell.DtHelpDialog*TocArea.background: blue
  826. <var>application_name<\var>*XmDialogShell.DtHelpDialog*TocArea.foreground: yellow
  827. <var>application_name<\var>*XmDialogShell*XmDialogShell.DtHelpDialog*TocArea.foreground:yellow
  828.  
  829.  
  830. <var>application_name<\var>*XmDialogShell.DtHelpQuickDialog*DisplayArea.background: blue
  831. <var>application_name<\var>*XmDialogShell.XmDialogShell.DtHelpQuickDialog*DisplayArea.background: blue
  832. <var>application_name<\var>*XmDialogShell.DtHelpQuickDialog*DisplayArea.foreground: yellow
  833. <var>application_name<\var>*XmDialogShell.XmDialogShell.DtHelpQuickDialog*DisplayArea.foreground: yellow
  834. <\ex>
  835.  
  836. <procedure>See Also
  837. <list bullet tight>
  838.  * <xref HelpWindowConfiguration>
  839.  * <xref Reference>
  840.  * <xref Tasks>
  841.  * <xref Table-Of-Contents>
  842.  * <link hyperlink="_hometopic">Home Topic<\link>
  843. <\list>
  844.  
  845. <s2 id=ToChangeHelpWindowDefaultSize>To Change Help Window Default Size
  846.  
  847. <idx |help windows, changing default size|
  848.  
  849. You can change the default window size for general help or quick help
  850. windows by modifying resources. The &dquote;rows&dquote; resource
  851. determines window height and the &dquote;columns&dquote; resource sets
  852. the window width. The display font affects window dimensions.
  853.  
  854.  
  855. <list order>
  856.  
  857. * Create an <computer>.Xdefaults<\computer> file in your home directory or
  858. edit your current <computer>.Xdefaults<\computer> file.
  859.  
  860. * Choose which resources you want to add from the examples which follow.
  861.  
  862.  
  863. * Replace <var>application_name<\var> with the name of the application you
  864. want to change and supply new rows and columns values. If you do not know
  865. the name of the application, consult your application documentation.
  866.  
  867.  
  868. * Start the application.
  869.  
  870. * To check the new window size, choose the application's Help menu. If
  871.   you have modified one of the quick help window types, be sure to 
  872.   choose a topic that is displayed in the type of window you have changed.
  873.   
  874. <\list>
  875.  
  876. <procedure>Examples
  877.  
  878. For all general help windows:
  879. <ex>
  880. <var>application_name<\var>*DtHelpDialog.rows: 65
  881. <var>application_name<\var>*DtHelpDialog.columns: 45
  882.  
  883. <\ex>
  884.  
  885. For all quick help windows:
  886.  
  887. <note>The Help System uses a quick help window to display
  888. copyright information, glossary terms, definition links, and 
  889. Using Help information. This example changes all instances
  890. of quick help windows.
  891. <\note>
  892.  
  893. <ex>
  894. <var>application_name<\var>*DtHelpQuickDialog.rows: 25
  895. <var>application_name<\var>*DtHelpQuickDialog.rows: 25
  896.  
  897. <\ex>
  898.  
  899. For quick help windows used to display Using Help and copyright
  900. information:
  901.  
  902. <ex>
  903. <var>application_name<\var>*onHelpDialog.rows: 25
  904. <var>application_name<\var>*onHelpDialog.columns: 25
  905. <\ex>
  906.  
  907.  
  908. For definition link quick help windows:
  909.  
  910. <ex>
  911. <var>application_name<\var>*definitionBox.rows: 10
  912. <var>application_name<\var>*definitionBox.columns: 20
  913.  
  914. <\ex>
  915.  
  916.  
  917. <procedure>See Also
  918. <list bullet tight>
  919.  * <xref HelpWindowConfiguration>
  920.  * <xref Reference>
  921.  * <xref Tasks>
  922.  * <xref Table-Of-Contents>
  923.  * <link hyperlink="_hometopic">Home Topic<\link>
  924.  <\list>
  925.  
  926. <s1 id=ErrorMessages>Help Error Messages
  927.  
  928. <idx |error messages|
  929. <list bullet>
  930. * If the Help System cannot find a help volume, it displays
  931.   this message:
  932.  
  933. <figure nonumber entity=Help4HelpVolErrMsg>
  934. <\figure>
  935.  
  936. Possible causes are:
  937. <list bullet>
  938. * The application's help volume is not installed
  939.  
  940. * Your desktop help search path does not include the directory
  941.   where the help volume has been installed.
  942.  
  943. Ask your system administrator to verify that the 
  944. application's help volume is properly installed and 
  945. that your help search paths are set correctly.
  946.  
  947. <\list>
  948.  
  949. * If the Help Viewer cannot find the ID of a help topic in a help 
  950.   volume, it displays a message like this:
  951.  
  952. <figure nonumber entity=Help4HelpIdErrMsg>
  953. <\figure>
  954.  
  955. Possible causes are:
  956. <list bullet>
  957. * A hyperlink points to a topic that does not exist or
  958. whose ID has been changed
  959.  
  960. * A hyperlink points to a valid ID in another help volume
  961. that is not installed
  962.  
  963.  
  964. Ask your system administrator to verify that the 
  965. application's help volume is properly installed and 
  966. that your help search paths are set correctly.
  967. <\list>
  968.  
  969.  
  970. * If the run-time help volume (<computer>.sdl<\computer> file) has an
  971.   error, the Help Viewer displays this message:
  972.  
  973. <figure nonumber entity=Help4HelpTopicErrMsg>
  974. <\figure>
  975.  
  976. Possible causes:
  977. <list bullet>
  978. * The run-time help volume may be incomplete or contain an error.
  979.  
  980. Ask your system administrator to check the help volume.
  981.  
  982. <\list>
  983. <\list>
  984. <procedure>See Also
  985. <list bullet tight>
  986.  * <xref Reference>
  987.  * <xref Tasks>
  988.  * <xref Table-Of-Contents>
  989.  * <link hyperlink="_hometopic">Home Topic<\link>
  990. <\list>
  991.  
  992.